Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow specifying a super template for async_track_template_result #58477

Merged
merged 7 commits into from
Oct 27, 2021

Conversation

emontnemery
Copy link
Contributor

@emontnemery emontnemery commented Oct 26, 2021

Proposed change

Allow specifying a super template for async_track_template_result
The super template suppresses rendering of other templates if it doesn't render as True.

The driver is to use this for template entities to block rendering of other templates when the availability template does not render as True

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

  • No score or internal
  • 馃 Silver
  • 馃 Gold
  • 馃弳 Platinum

To help with the load of incoming pull requests:

@probot-home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (websocket_api) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@probot-home-assistant
Copy link

Hey there @PhracturedBlue, @tetienne, @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (template) you are listed as a code owner for? Thanks!
(message by CodeOwnersMention)

@balloob
Copy link
Member

balloob commented Oct 26, 2021

What changed the behavior that this is an issue now?

@emontnemery
Copy link
Contributor Author

emontnemery commented Oct 27, 2021

What changed the behavior that this is an issue now?

The change is that many template functions and filters now log warnings when the input is not valid, and as suggested in the linked issue #57287, it's reasonable that they don't when the availability template doesn't render True.

Comment on lines 963 to 964
if master_result is not None and master_result is not True:
break
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move this check into the if statemenet when you assign master_result

@emontnemery emontnemery changed the title Allow specifying a master template for async_track_template_result Allow specifying a super template for async_track_template_result Oct 27, 2021
Dev automation moved this from Needs review to Reviewer approved Oct 27, 2021
@emontnemery emontnemery marked this pull request as draft October 27, 2021 10:01
@emontnemery
Copy link
Contributor Author

Availability is set to True if the availability template returns either of [True, "1", "true", "yes", "on", "enable"] or if it throws; marking this as draft until that's handled

@emontnemery emontnemery marked this pull request as ready for review October 27, 2021 11:13
@frenck frenck merged commit bed4096 into dev Oct 27, 2021
Dev automation moved this from Reviewer approved to Done Oct 27, 2021
@frenck frenck deleted the async_track_template_result_master_template branch October 27, 2021 14:07
@github-actions github-actions bot locked and limited conversation to collaborators Oct 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
Dev
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants